Ficha técnica

Alcances necesarios

El token para consumir la API de Recibibles de tarjeta de crédito debe generarse utilizando el Authorization Code.

El alcance openid es obligatorio. Permite consultar el perfil del usuario BTG con acceso a la cuenta.

Es necesario indicar uno de los siguientes alcances al realizar el flujo:

Alcance	Descripción
brn:btg:empresas:receivables:credit-card	Permite la consulta de datos y la creación de un anticipo de recibible
brn:btg:empresas:receivables:credit-card.readonly	Permite la consulta de datos de un anticipo de recibible
brn:btg:empresas:scf:sub-acquirers	Permite la utilización de las APIs de subadquirente y bancos emisores

Máquina de estados del Recibible

Códigos de Error

La siguiente tabla contiene los códigos de error que la API devuelve cuando falla en operar, y sus respectivas descripciones indicando la causa del error.

Código	Descripción
OPRCC000	Error inesperado
OPRCC001	Empresa no registrada
OPRCC002	Cuenta de Desembolso no registrada
OPRCC003	Ningún recibible solicitado fue encontrado
OPRCC004	Los recibibles solicitados no pertenecen a la empresa
OPRCC005	Los recibibles solicitados no están disponibles para anticipar
OPRCC006	Monto solicitado mayor que el monto disponible para anticipar
OPRCC007	Monto solicitado menor que el monto mínimo posible
OPRCC008	Límite no registrado para la empresa
OPRCC009	Operación fuera del horario establecido
OPRCC010	La empresa no puede operar por no pagar el Saldo Deudor
OPRCC011	Paginador con valores inconsistentes

Eventos de webhook

Los payloads disponibles a continuación representan el contenido del campo data, siguiendo el formato de envío descrito en Eventos.

Evento	Descripción
receivables-credit-card.balance-summary	Informe del saldo deudor
receivables-credit-card.batch-receivable-update	Actualización de los recibibles en lote
receivables-credit-card.batch-operation-update	Actualización de las operaciones en lote
receivables-credit-card.sub-acquirer.batch-receivable-update	Actualización de los recibibles de subadquirentes en lote

receivables-credit-card.balance-summary

Enviado todos los días a las 10h.

{
    "companyId": "37297902000141",
    "dueTodayReceivablesUnpaidAmount": "0.00",
    "overdueReceivablesUnpaidAmount": "0.00",
    "receivablesOverdue": [
    {
        "status": "InDisbursement",
        "balance": "114.72",
        "interestArrears": "0.50",
        "latePaymentFee": "0",
        "penaltyFee": "2.30",
        "maturityDate": "2025-01-29"
    }
  ]
}

receivables-credit-card.batch-receivable-update

[
    {
        "receivable": {
            "receivableId": 107629006,
            "payerId": "01027058000191",
            "payeeId": "37297902000141",
            "maturityDate": "2025-07-17",
            "scheme": "Elo",
            "maturityAmount": "4913.42",
            "status": "WaitingSignatures"
        },
        "registeredAmount": "0.00",
        "disbursementAmount": "4900.15"
    },
    {
        "receivable": {
            "receivableId": 107629612,
            "payerId": "01027058000191",
            "payeeId": "37297902000141",
            "maturityDate": "2025-07-18",
            "scheme": "AmericanExpress",
            "maturityAmount": "1065.60",
            "status": "WaitingSignatures"
        },
        "registeredAmount": "0.00",
        "disbursementAmount": "1061.76"
    }
]

receivables-credit-card.batch-operation-update

[
    {
        "operation": {
            "operationId": 59428,
            "status": "Cancelled",
            "payerId": "01027058000191",
            "payeeId": "37297902000141"
        }
    }
]